Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes for 'unprivileged' agent docs #1200

Merged
merged 8 commits into from
Jul 23, 2024
Merged

Fixes for 'unprivileged' agent docs #1200

merged 8 commits into from
Jul 23, 2024

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jul 19, 2024 •
edited
Loading

This updates the Run Elastic Agent without administrative privileges page based on suggestions in #1197

Closes: #1197

Preview pages:

Fixes mapped to the "Unprivileged mode docs review" issue

  1. Updates the warning about running commands in unprivileged mode to be more clear.

  2. Describes the privileged and unprivileged commands for changing an agent's running mode.

  3. Nothing to do for now.

  4. Adds steps to view an agent's running status (privileged vs unprivileged) in the "Agent details" UI.

  5. Nothing to do for now.

Additional fix

  1. Updates the Command Reference to the --privileged parameter to the elastic-agent install command.
    @ycombinator Do you think elastic-agent privileged and elastic-agent unprivileged should also be documented as full commands, similar to elastic-agent inspect, elastic-agent status, etc.? From Add unprivileged and privileged subcommand to Elastic Agent elastic-agent#4621 it seems so. That is, they're actual commands rather than just parameters on the elastic-agent install command. However, these are also referred to as "subcommands" so I'm kind of puzzled. :-)

@kilfoyle kilfoyle requested a review from a team as a code owner July 19, 2024 15:12
@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

This was referenced Jul 19, 2024
Closed
Closed
@kilfoyle kilfoyle marked this pull request as draft July 19, 2024 16:03
@kilfoyle kilfoyle marked this pull request as ready for review July 19, 2024 17:07
lucabelluccini
lucabelluccini requested changes Jul 19, 2024
View reviewed changes
Copy link
Contributor

@lucabelluccini lucabelluccini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might need another 👀 from the developers, but in the meanwhile, 🙇‍♂️ Thanks

docs/en/ingest-management/commands.asciidoc Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Show resolved Hide resolved
docs/en/ingest-management/elastic-agent/elastic-agent-unprivileged-mode.asciidoc Show resolved Hide resolved
docs/en/ingest-management/elastic-agent/elastic-agent-unprivileged-mode.asciidoc Show resolved Hide resolved
@ycombinator
Copy link
Contributor

Updates the Command Reference to the --privileged parameter to the elastic-agent install command.
@ycombinator Do you think elastic-agent privileged and elastic-agent unprivileged should also be documented as full commands, similar to elastic-agent inspect, elastic-agent status, etc.? From elastic/elastic-agent#4621 it seems so. That is, they're actual commands rather than just parameters on the elastic-agent install command.

Yes, I would agree that elastic-agent privileged and elastic-agent unprivileged should also documented as commands similar to other commands such as elastic-agent inspect, etc.

However, these are also referred to as "subcommands" so I'm kind of puzzled. :-)

I can understand the confusion 🙂. We sometimes refer to the the word that comes after the initial elastic-agent as a sub-command, with elastic-agent being the command. Hope that helps clarify the confusion.

@kilfoyle
Copy link
Contributor Author

Thanks @lucabelluccini and @ycombinator for clearing things up! I've added in commands for elastic-agent privileged and elastic-agent unprivileged, and I've also kept the --privileged and --unprivileged flags for the elastic-agent install command.

@kilfoyle kilfoyle requested a review from blakerouse July 23, 2024 19:15
blakerouse
blakerouse approved these changes Jul 23, 2024
View reviewed changes
Copy link
Contributor

@blakerouse blakerouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes look good.

karenzone
karenzone approved these changes Jul 23, 2024
View reviewed changes
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kilfoyle kilfoyle merged commit e409b9d into elastic:main Jul 23, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Jul 23, 2024
@kilfoyle @mergify
Fixes for 'unprivileged' agent docs (#1200)
3e69a44 
* Fixes for 'unprivileged' agent docs

* Add clause about required re-enroll

* fixup

* Improve warning about running sub-commands without sudo

* Add 'privileged' and 'unprivileged' as commands

* Note that sudo is still needed for install command

* fixup

* Fixup

(cherry picked from commit e409b9d)
@mergify mergify bot mentioned this pull request Jul 23, 2024
Merged
kilfoyle added a commit that referenced this pull request Jul 23, 2024
@mergify @kilfoyle
Fixes for 'unprivileged' agent docs (#1200) (#1204)
369d240 
* Fixes for 'unprivileged' agent docs

* Add clause about required re-enroll

* fixup

* Improve warning about running sub-commands without sudo

* Add 'privileged' and 'unprivileged' as commands

* Note that sudo is still needed for install command

* fixup

* Fixup

(cherry picked from commit e409b9d)

Co-authored-by: David Kilfoyle <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blakerouse blakerouse blakerouse approved these changes

@karenzone karenzone karenzone approved these changes

@lucabelluccini lucabelluccini Awaiting requested review from lucabelluccini

Assignees
No one assigned
Labels
backport-8.15
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOCS] Unprivileged mode docs review
5 participants
@kilfoyle @ycombinator @lucabelluccini @blakerouse @karenzone